Skip to main content

getAppointment​

getAppointment

Header Parameters
    authorization string required

    authorization

Request Body required

request

    appointmentKey string
    appointmentUUID string
    dealerDepartmentUuidList string[]
    dealerUuid string
    requesterUserUuid string
Responses

OK

Schema
    error object
    code string
    description string
    metadata object
    property name* string
    serviceAppointment object
    appointmentKey string
    appointmentType string

    Possible values: [MOBILE_SERVICE, REGULAR_SERVICE]

    assignedUser object
    departmentUuid string
    isMobileServiceTechnician boolean
    isValid boolean
    userUuid string
    createdByUser object
    departmentUuid string
    isMobileServiceTechnician boolean
    isValid boolean
    userUuid string
    createdTimeStamp date-time
    customerUUID string
    customerVehicleUUID string
    dealerUUID string
    destinationAddress string
    destinationLatitude double
    destinationLongitude double
    emailPreference boolean
    internalNotes string
    lastMileage string
    platform string

    Possible values: [DEALER_APP, WEB, MOBILE_APP, DMS, TRANSPORTATION_EVENTS_CONSUMER]

    preferredDate string
    publicNotes string
    quickOpList object[]
  • Array [
    • description string
    laborOpCode string
    opCodeDuration string
    opCodeName string
    quickOpLiteUUID string
    totalPrice string
  • ]
    • serviceAdvisor object
    departmentUuid string
    isMobileServiceTechnician boolean
    isValid boolean
    userUuid string
    serviceEndTime string
    serviceStartTime string
    sprinterVehicleUUID string
    status string

    Possible values: [PENDING_APPROVAL, SCHEDULED, TRIP_IN_PROGRESS, TECHNICIAN_ARRIVED, SERVICE_IN_PROGRESS, SERVICE_COMPLETED, CANCELLED, COMPLETED, DECLINED]

    textPreference boolean
    uuid string
    statusCode int32
    warnings object[]
  • Array [
    • code string
    description string
  • ]
POST /appointment/fetch

Request

Base URL
//api.mykaarma.com/mobile-service
authorization — header required
Body required
{

  "appointmentKey": "string",

  "appointmentUUID": "string",

  "dealerDepartmentUuidList": [

    "string"

  ],

  "dealerUuid": "string",

  "requesterUserUuid": "string"

}
curl / cURL
curl -L -X POST '//api.mykaarma.com/mobile-service/appointment/fetch' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "appointmentKey": "string",
  "appointmentUUID": "string",
  "dealerDepartmentUuidList": [
    "string"
  ],
  "dealerUuid": "string",
  "requesterUserUuid": "string"
}'